/*******************************************************************************
* Copyright (c) 2007, 2008, CerroKai Development
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*     * Redistributions of source code must retain the above copyright
*       notice, this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of CerroKai Development nor the
*       names of its contributors may be used to endorse or promote products
*       derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY CerroKai Development ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL CerroKai Development BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
********************************************************************************/


#ifndef __FRAME_RATE_MONITOR_H__
#define __FRAME_RATE_MONITOR_H__


/*** Included Header Files ***/
#include <Scene/wscnl.h>
#include <Scene/overlay.h>


/*** Locally Defined Values ***/
#define FRAMERATEMONITOR_WIDTH					1.5
#define FRAMERATEMONITOR_HEIGHT					0.4
#define FRAMERATEMONITOR_BORDER					0.15
#define FRAMERATEMONITOR_DEFAULT_COLOR			1.0, 1.0, 1.0, 1.0


/*** Namespace Declaration ***/
namespace __WILDCAT_NAMESPACE__ {


/*** Class Predefines ***/
class WCUserInterfaceLayer;
class WCColor;
class WCText;


/***********************************************~***************************************************/


class WCFrameRateMonitor : public WCOverlay {
protected:
	WPInt										_frameCounter;										//!< Number of frames in this second
	WPTime										_start;												//!< Time start marker
	WPFloat										_fps;												//!< Calculated fps
	WCColor										_color;												//!< FRM color
	WCText										*_label;											//!< FRM label
private:
	WCFrameRateMonitor();																			//!< Deny access to default constructor
	WCFrameRateMonitor(const WCFrameRateMonitor &frm);												//!< Deny access to copy constructor
	WCFrameRateMonitor& operator=(const WCFrameRateMonitor &frm);									//!< Deny access to equals operator
public:
	//Constructors and Destructors
	WCFrameRateMonitor(WCUserInterfaceLayer *layer);												//!< Primary constructor
	~WCFrameRateMonitor();																			//!< Default destructor

	//Overloaded Operators
	void operator()(void);																			//!< Frame tick callback function

	//Inherited Methods
	void OnIdle(void)							{ this->MarkDirty(); }								//!< On idle response
	void OnReshape(void);																			//!< Modify placement on resize
	void Render(void);																				//!< Render the FRM
};


/***********************************************~***************************************************/


}	   // End Wildcat Namespace
#endif //__FRAME_RATE_MONITOR_H__

